<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GstAudioVisualizer: GStreamer Base Plugins 1.0 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual">
<link rel="up" href="gstreamer-base-utils.html" title="Base Utils Library">
<link rel="prev" href="GstEncodingProfile.html" title="GstEncodingProfile">
<link rel="next" href="gstreamer-video.html" title="Video Library">
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GstAudioVisualizer.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GstAudioVisualizer.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GstAudioVisualizer.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="gstreamer-base-utils.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GstEncodingProfile.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gstreamer-video.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GstAudioVisualizer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GstAudioVisualizer.top_of_page"></a>GstAudioVisualizer</span></h2>
<p>GstAudioVisualizer — Base class for visualizers.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GstAudioVisualizer.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody><tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="GstAudioVisualizer.html#GstAudioVisualizerShaderFunc" title="GstAudioVisualizerShaderFunc ()">*GstAudioVisualizerShaderFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GstAudioVisualizer.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
<td class="property_name"><a class="link" href="GstAudioVisualizer.html#GstAudioVisualizer--shade-amount" title="The “shade-amount” property">shade-amount</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="GstAudioVisualizer.html#GstAudioVisualizerShader" title="enum GstAudioVisualizerShader"><span class="type">GstAudioVisualizerShader</span></a></td>
<td class="property_name"><a class="link" href="GstAudioVisualizer.html#GstAudioVisualizer--shader" title="The “shader” property">shader</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GstAudioVisualizer.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GstAudioVisualizer.html#GstAudioVisualizer-struct" title="struct GstAudioVisualizer">GstAudioVisualizer</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GstAudioVisualizer.html#GstAudioVisualizerClass" title="struct GstAudioVisualizerClass">GstAudioVisualizerClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GstAudioVisualizer.html#GstAudioVisualizerShader" title="enum GstAudioVisualizerShader">GstAudioVisualizerShader</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GstAudioVisualizer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a>
    <span class="lineart">╰──</span> GstAudioVisualizerShader
    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
                <span class="lineart">╰──</span> GstAudioVisualizer
</pre>
</div>
<div class="refsect1">
<a name="GstAudioVisualizer.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gst/pbutils/pbutils.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GstAudioVisualizer.description"></a><h2>Description</h2>
<p>A baseclass for scopes (visualizers). It takes care of re-fitting the
audio-rate to video-rate and handles renegotiation (downstream video size
changes).</p>
<p>It also provides several background shading effects. These effects are
applied to a previous picture before the <code class="function">render()</code> implementation can draw a
new frame.</p>
</div>
<div class="refsect1">
<a name="GstAudioVisualizer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GstAudioVisualizerShaderFunc"></a><h3>GstAudioVisualizerShaderFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GstAudioVisualizerShaderFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="GstAudioVisualizer.html" title="GstAudioVisualizer"><span class="type">GstAudioVisualizer</span></a> *scope</code></em>,
                                 <em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-GstVideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *s</code></em>,
                                 <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *d</code></em>);</pre>
</div>
</div>
<div class="refsect1">
<a name="GstAudioVisualizer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstAudioVisualizer-struct"></a><h3>struct GstAudioVisualizer</h3>
<pre class="programlisting">struct GstAudioVisualizer;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GstAudioVisualizerClass"></a><h3>struct GstAudioVisualizerClass</h3>
<pre class="programlisting">struct GstAudioVisualizerClass {
  /* virtual function, called whenever the format changes */
  gboolean (*setup) (GstAudioVisualizer * scope);

  /* virtual function for rendering a frame */
  gboolean (*render) (GstAudioVisualizer * scope, GstBuffer * audio, GstVideoFrame * video);

  gboolean (*decide_allocation)   (GstAudioVisualizer * scope, GstQuery *query);
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GstAudioVisualizerShader"></a><h3>enum GstAudioVisualizerShader</h3>
<p>Different types of supported background shading functions.</p>
<div class="refsect3">
<a name="GstAudioVisualizerShader.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GST-AUDIO-VISUALIZER-SHADER-NONE:CAPS"></a>GST_AUDIO_VISUALIZER_SHADER_NONE</p></td>
<td class="enum_member_description">
<p>no shading</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GST-AUDIO-VISUALIZER-SHADER-FADE:CAPS"></a>GST_AUDIO_VISUALIZER_SHADER_FADE</p></td>
<td class="enum_member_description">
<p>plain fading</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GST-AUDIO-VISUALIZER-SHADER-FADE-AND-MOVE-UP:CAPS"></a>GST_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_UP</p></td>
<td class="enum_member_description">
<p>fade and move up</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GST-AUDIO-VISUALIZER-SHADER-FADE-AND-MOVE-DOWN:CAPS"></a>GST_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_DOWN</p></td>
<td class="enum_member_description">
<p>fade and move down</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GST-AUDIO-VISUALIZER-SHADER-FADE-AND-MOVE-LEFT:CAPS"></a>GST_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_LEFT</p></td>
<td class="enum_member_description">
<p>fade and move left</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GST-AUDIO-VISUALIZER-SHADER-FADE-AND-MOVE-RIGHT:CAPS"></a>GST_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_RIGHT</p></td>
<td class="enum_member_description">
<p>fade and move right</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GST-AUDIO-VISUALIZER-SHADER-FADE-AND-MOVE-HORIZ-OUT:CAPS"></a>GST_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_HORIZ_OUT</p></td>
<td class="enum_member_description">
<p>fade and move horizontally out</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GST-AUDIO-VISUALIZER-SHADER-FADE-AND-MOVE-HORIZ-IN:CAPS"></a>GST_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_HORIZ_IN</p></td>
<td class="enum_member_description">
<p>fade and move horizontally in</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GST-AUDIO-VISUALIZER-SHADER-FADE-AND-MOVE-VERT-OUT:CAPS"></a>GST_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_VERT_OUT</p></td>
<td class="enum_member_description">
<p>fade and move vertically out</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GST-AUDIO-VISUALIZER-SHADER-FADE-AND-MOVE-VERT-IN:CAPS"></a>GST_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_VERT_IN</p></td>
<td class="enum_member_description">
<p>fade and move vertically in</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GstAudioVisualizer.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstAudioVisualizer--shade-amount"></a><h3>The <code class="literal">“shade-amount”</code> property</h3>
<pre class="programlisting">  “shade-amount”             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
<p>Shading color to use (big-endian ARGB).</p>
<p>Flags: Read / Write</p>
<p>Default value: 657930</p>
</div>
<hr>
<div class="refsect2">
<a name="GstAudioVisualizer--shader"></a><h3>The <code class="literal">“shader”</code> property</h3>
<pre class="programlisting">  “shader”                   <a class="link" href="GstAudioVisualizer.html#GstAudioVisualizerShader" title="enum GstAudioVisualizerShader"><span class="type">GstAudioVisualizerShader</span></a></pre>
<p>Shader function to apply on each frame.</p>
<p>Flags: Read / Write</p>
<p>Default value: GST_AUDIO_VISUALIZER_SHADER_FADE</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28</div>
</body>
</html>